<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::LevelSetShape Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_level_set_shape.html">LevelSetShape</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_level_set_shape-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::LevelSetShape Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A shape using level set to define geometry.  
 <a href="class_s_p_h_1_1_level_set_shape.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="level__set__shape_8h_source.html">level_set_shape.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_shape.html">SPH::Shape</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0bede88799f1fecf87cbb12eb9548b51"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_level_set_shape.html#a0bede88799f1fecf87cbb12eb9548b51">LevelSetShape</a> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *sph_body, <a class="el" href="class_s_p_h_1_1_shape.html">Shape</a> &amp;shape, Real refinement_ratio=1.0)</td></tr>
<tr class="separator:a0bede88799f1fecf87cbb12eb9548b51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b96e577d2ae384dfa3583543ceaeda"><td class="memItemLeft" align="right" valign="top"><a id="a62b96e577d2ae384dfa3583543ceaeda"></a>
virtual <a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><b>checkContain</b> (const Vecd &amp;input_pnt, <a class="el" href="classbool.html">bool</a> BOUNDARY_INCLUDED=true) override</td></tr>
<tr class="separator:a62b96e577d2ae384dfa3583543ceaeda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee39bea735a9fa6181b5f5a975e85519"><td class="memItemLeft" align="right" valign="top"><a id="aee39bea735a9fa6181b5f5a975e85519"></a>
virtual Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>findClosestPoint</b> (const Vecd &amp;input_pnt) override</td></tr>
<tr class="separator:aee39bea735a9fa6181b5f5a975e85519"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40f88d9612a1c4bb84901af8a13b1bb0"><td class="memItemLeft" align="right" valign="top"><a id="a40f88d9612a1c4bb84901af8a13b1bb0"></a>
Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>findLevelSetGradient</b> (const Vecd &amp;input_pnt)</td></tr>
<tr class="separator:a40f88d9612a1c4bb84901af8a13b1bb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e38c8fbbd8308c5541bb98c8b769d2c"><td class="memItemLeft" align="right" valign="top"><a id="a9e38c8fbbd8308c5541bb98c8b769d2c"></a>
Real&#160;</td><td class="memItemRight" valign="bottom"><b>computeKernelIntegral</b> (const Vecd &amp;input_pnt, Real h_ratio=1.0)</td></tr>
<tr class="separator:a9e38c8fbbd8308c5541bb98c8b769d2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf79ed92d3da2870c71c234dd7e8c58b"><td class="memItemLeft" align="right" valign="top"><a id="acf79ed92d3da2870c71c234dd7e8c58b"></a>
Vecd&#160;</td><td class="memItemRight" valign="bottom"><b>computeKernelGradientIntegral</b> (const Vecd &amp;input_pnt, Real h_ratio=1.0)</td></tr>
<tr class="separator:acf79ed92d3da2870c71c234dd7e8c58b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a397a63a3280cd13808f7f148b1de1277"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_s_p_h_1_1_level_set_shape.html">LevelSetShape</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_level_set_shape.html#a397a63a3280cd13808f7f148b1de1277">cleanLevelSet</a> (Real small_shift_factor=1.0)</td></tr>
<tr class="separator:a397a63a3280cd13808f7f148b1de1277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b4c52629d3c94e0c8e03569141a85a8"><td class="memItemLeft" align="right" valign="top"><a id="a3b4c52629d3c94e0c8e03569141a85a8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeLevelSet</b> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> &amp;sph_body)</td></tr>
<tr class="separator:a3b4c52629d3c94e0c8e03569141a85a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_shape"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_shape')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_shape.html">SPH::Shape</a></td></tr>
<tr class="memitem:a1c9fde7ad7ef1883a53508fce789cfc8 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a1c9fde7ad7ef1883a53508fce789cfc8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Shape</b> (const std::string &amp;shape_name)</td></tr>
<tr class="separator:a1c9fde7ad7ef1883a53508fce789cfc8 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace0e6216880b5ccb462523aa821a50b3 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="ace0e6216880b5ccb462523aa821a50b3"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>getName</b> ()</td></tr>
<tr class="separator:ace0e6216880b5ccb462523aa821a50b3 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6337edd9c272044cb7f1fa60c927395 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="af6337edd9c272044cb7f1fa60c927395"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setName</b> (const std::string &amp;name)</td></tr>
<tr class="separator:af6337edd9c272044cb7f1fa60c927395 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b193691a25da216949134ee547a1dd4 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a0b193691a25da216949134ee547a1dd4"></a>
<a class="el" href="class_s_p_h_1_1_base_bounding_box.html">BoundingBox</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getBounds</b> ()</td></tr>
<tr class="separator:a0b193691a25da216949134ee547a1dd4 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b46b069ecc818d37a2a0ed9ed0a3f82 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a5b46b069ecc818d37a2a0ed9ed0a3f82"></a>
virtual <a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><b>isValid</b> ()</td></tr>
<tr class="separator:a5b46b069ecc818d37a2a0ed9ed0a3f82 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95e323f0bea0577f88c77e67b99743a5 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a95e323f0bea0577f88c77e67b99743a5"></a>
<a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><b>checkNotFar</b> (const Vecd &amp;input_pnt, Real threshold)</td></tr>
<tr class="separator:a95e323f0bea0577f88c77e67b99743a5 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1368ee142ede83fc6d7ef0ffae15b51 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="aa1368ee142ede83fc6d7ef0ffae15b51"></a>
<a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><b>checkNearSurface</b> (const Vecd &amp;input_pnt, Real threshold)</td></tr>
<tr class="separator:aa1368ee142ede83fc6d7ef0ffae15b51 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22a00542237b211eddb3e54b8a6eb856 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_shape.html#a22a00542237b211eddb3e54b8a6eb856">findSignedDistance</a> (const Vecd &amp;input_pnt)</td></tr>
<tr class="separator:a22a00542237b211eddb3e54b8a6eb856 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc828b144936617d50e977ae301b0e0 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top">Vecd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_shape.html#adfc828b144936617d50e977ae301b0e0">findNormalDirection</a> (const Vecd &amp;input_pnt)</td></tr>
<tr class="separator:adfc828b144936617d50e977ae301b0e0 inherit pub_methods_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab0516b00896c54930cd291d0544891de"><td class="memItemLeft" align="right" valign="top"><a id="ab0516b00896c54930cd291d0544891de"></a>
virtual <a class="el" href="class_s_p_h_1_1_base_bounding_box.html">BoundingBox</a>&#160;</td><td class="memItemRight" valign="bottom"><b>findBounds</b> () override</td></tr>
<tr class="separator:ab0516b00896c54930cd291d0544891de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a33ff860a3e8296883958d56912f55ab1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_s_p_h_1_1_base_level_set.html">BaseLevelSet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_level_set_shape.html#a33ff860a3e8296883958d56912f55ab1">level_set_</a></td></tr>
<tr class="separator:a33ff860a3e8296883958d56912f55ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_s_p_h_1_1_shape"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_s_p_h_1_1_shape')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_s_p_h_1_1_shape.html">SPH::Shape</a></td></tr>
<tr class="memitem:a8e6dd281937b9208b4cdd221e7feaa51 inherit pro_attribs_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a8e6dd281937b9208b4cdd221e7feaa51"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>name_</b></td></tr>
<tr class="separator:a8e6dd281937b9208b4cdd221e7feaa51 inherit pro_attribs_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a955c2bbaa9e4684d3b22658f05286458 inherit pro_attribs_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a955c2bbaa9e4684d3b22658f05286458"></a>
<a class="el" href="class_s_p_h_1_1_base_bounding_box.html">BoundingBox</a>&#160;</td><td class="memItemRight" valign="bottom"><b>bounding_box_</b></td></tr>
<tr class="separator:a955c2bbaa9e4684d3b22658f05286458 inherit pro_attribs_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18bd2c945133cc142708e14468a29d5d inherit pro_attribs_class_s_p_h_1_1_shape"><td class="memItemLeft" align="right" valign="top"><a id="a18bd2c945133cc142708e14468a29d5d"></a>
<a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><b>is_bounds_found_</b></td></tr>
<tr class="separator:a18bd2c945133cc142708e14468a29d5d inherit pro_attribs_class_s_p_h_1_1_shape"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A shape using level set to define geometry. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0bede88799f1fecf87cbb12eb9548b51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bede88799f1fecf87cbb12eb9548b51">&#9670;&nbsp;</a></span>LevelSetShape()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SPH::LevelSetShape::LevelSetShape </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> *&#160;</td>
          <td class="paramname"><em>sph_body</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_shape.html">Shape</a> &amp;&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>refinement_ratio</em> = <code>1.0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>refinement_ratio is between body reference resolution and level set resolution </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a397a63a3280cd13808f7f148b1de1277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a397a63a3280cd13808f7f148b1de1277">&#9670;&nbsp;</a></span>cleanLevelSet()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_level_set_shape.html">LevelSetShape</a> * SPH::LevelSetShape::cleanLevelSet </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>small_shift_factor</em> = <code>1.0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>small_shift_factor = 1.0 by default, can be increased for difficult geometries for smoothing </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a33ff860a3e8296883958d56912f55ab1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ff860a3e8296883958d56912f55ab1">&#9670;&nbsp;</a></span>level_set_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_base_level_set.html">BaseLevelSet</a>* SPH::LevelSetShape::level_set_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>narrow bounded level set mesh. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/geometries/<a class="el" href="level__set__shape_8h_source.html">level_set_shape.h</a></li>
<li>SPHINXsys/src/shared/geometries/<a class="el" href="level__set__shape_8cpp.html">level_set_shape.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
